//
// PropsCipher
//
// Copyright (C) jextra.net.
//
//  This file is part of the JavaProps Library.
//
//  The JavaProps Library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//
//  The JavaProps Library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with the JavaProps Library; if not, write to the Free
//  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
//  02111-1307 USA.
//

package net.jextra.props;

/**
 * <p>
 * Implement this interface in order to provider a means of decrypting any encrypted property values
 * (e.g. passwords) accessed via {@link Props#getEncryptedString}. 
 * <p></p>
 * Note, there is no <code>encipher</code> method because the Props package does not directly 
 * require the ability to encipher strings; it is assumed that the enciphered String stored in the 
 * property is calculated elsewhere.
 * </p>
 */
public interface PropsCipher
{
    String decipher( String string );
}

